SGI Freeware 1999 August

home *** CD-ROM | disk | FTP | other *** search

/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_sharutils.idb / usr / freeware / catman / u_man / cat1 / shar.Z / shar

Wrap

Text File | 1998-05-21 | 15.2 KB | 398 lines

/xlv1/freeware/1998.May/sharutils/4.2/sharutils-4.2.diffbuild/doc SSSSHHHHAAAARRRR((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11110000,,,, 1111999999995555)))) SSSSHHHHAAAARRRR((((1111)))) NNNNAAAAMMMMEEEE shar - create shell archives SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS shar [ options ] file ... shar -S [ options ] DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN Shar creates "shell archives" (or shar files) which are in text format and can be mailed. These files may be unpacked later by executing them with /bin/sh. The resulting archive is sent to standard out unless the -_o option is given. A wide range of features provide extensive flexibility in manufacturing shars and in specifying shar "smartness". Archives may be "vanilla" or comprehensive. OOOOPPPPTTTTIIIIOOOONNNNSSSS Options have a one letter version starting with - or a long version starting with --. The exception is --_h_e_l_p, --_v_e_r_s_i_o_n, --_n_o-_i_1_8_n and --_p_r_i_n_t-_t_e_x_t-_d_o_m_a_i_n-_d_i_r which does not have short versions. Mandatory arguments to long options are mandatory for short options too. Options can be given in any order. Some options depend on each other: The -_o option is required if the -_l or -_L option is used. The -_n option is required if the -_a option is used. See -_V below. GGGGiiiivvvviiiinnnngggg ffffeeeeeeeeddddbbbbaaaacccckkkk:::: --_h_e_l_p Print a help summary on standard output, then immediately exits. --_v_e_r_s_i_o_n Print the version number of the program on standard output, then immediately exits. -_q --_q_u_i_e_t --_s_i_l_e_n_t Do not output verbose messages locally when producing the archive. SSSSeeeelllleeeeccccttttiiiinnnngggg ffffiiiilllleeeessss:::: -_p --_i_n_t_e_r_m_i_x-_t_y_p_e Allow positional parameter options. The options -_B, -_T, -_z and -_Z may be embedded, and files to the right of the option will be processed in the specified mode. -_S --_s_t_d_i_n-_f_i_l_e-_l_i_s_t Read list of files to be packed from the standard input rather than from the command line. Input must be in a form similar to that generated by the find command, one filename per line. This switch is especially useful when the command line will not hold the list of files Page 1 (printed 5/18/98) SSSSHHHHAAAARRRR((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11110000,,,, 1111999999995555)))) SSSSHHHHAAAARRRR((((1111)))) to be packed. For example: find . -type f -print | sort | shar -S -Z -L50 -o /tmp/big If -_p is specified on the command line, then the options -_B, -_T, -_z and -_Z may be included in the standard input (on a line separate from filenames). The maximum number of lines of standard input, file names and options, may not exceed 1024. SSSSpppplllliiiittttttttiiiinnnngggg oooouuuuttttppppuuuutttt:::: -_o XXX --_o_u_t_p_u_t-_p_r_e_f_i_x=XXX Save the archive to files XXX.01 thru XXX.nn instead of sending it to standard out. Must be used when the -_l or the -_L switches are used. -_l XX --_w_h_o_l_e-_s_i_z_e-_l_i_m_i_t=XX Limit the output file size to XXk bytes but don't split input files. -_L XX --_s_p_l_i_t-_s_i_z_e-_l_i_m_i_t=XX Limit output file size to XXk bytes and split files if necessary. The archive parts created with this option must be unpacked in correct order. CCCCoooonnnnttttrrrroooolllllllliiiinnnngggg tttthhhheeee sssshhhhaaaarrrr hhhheeeeaaaaddddeeeerrrrssss:::: -_n name --_a_r_c_h_i_v_e-_n_a_m_e=name Name of archive to be included in the header of the shar files. See the -_a switch. -_s who@where --_s_u_b_m_i_t_t_e_r=who@where Override automatically determined submitter name. -_a --_n_e_t-_h_e_a_d_e_r_s Allows automatic generation of headers: Submitted-by: who@where Archive-name: <name>/part## The <name> must be given with the -_n switch. If name includes a '/' "/part" isn't used. Thus: -n xyzzy produces: xyzzy/part01 xyzzy/part02 -n xyzzy/patch produces: xyzzy/patch01 xyzzy/patch02 -n xyzzy/patch01. produces: xyzzy/patch01.01 xyzzy/patch01.02 The who@where can be explicitly stated with the -_s Page 2 (printed 5/18/98) SSSSHHHHAAAARRRR((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11110000,,,, 1111999999995555)))) SSSSHHHHAAAARRRR((((1111)))) switch if the default isn't appropriate. Who@where is essentially built as `whoami`@`uname`. -_c --_c_u_t-_m_a_r_k Start the shar with a cut line. A line saying 'Cut here' is placed at the start of each output file. SSSSeeeelllleeeeccccttttiiiinnnngggg hhhhoooowwww ffffiiiilllleeeessss aaaarrrreeee ssssttttoooocccckkkkeeeedddd:::: -_M --_m_i_x_e_d-_u_u_e_n_c_o_d_e Mixed mode. Determine if the files are text or binary and archive correctly (default). Files found to be binary are uudecoded prior to packing (USE OF UUENCODE IS NOT APPRECIATED BY MANY ON THE NET). -_T --_t_e_x_t-_f_i_l_e_s Treat all files as text. -_B --_u_u_e_n_c_o_d_e Treat all files as binary, use uuencode prior to packing. This increases the size of the archive. The recipient must have uudecode in order to unpack. (USE OF UUENCODE IS NOT APPRECIATED BY MANY ON THE NET). -_z --_g_z_i_p Gzip and uuencode all files prior to packing. The recipient must have uudecode and gzip in order to unpack (USE OF UUENCODE AND GZIP IS NOT APPRECIATED BY MANY ON THE NET). -_g LEVEL --_l_e_v_e_l-_f_o_r-_g_z_i_p=LEVEL When doing compression, use '-LEVEL' as a parameter to gzip. Default is 9. The -_g option turns on the -_z option by default. -_Z --_c_o_m_p_r_e_s_s Compress and uuencode all files prior to packing. The recipient must have uudecode and compress in order to unpack (USE OF UUENCODE AND COMPRESS IS NOT APPRECIATED BY MANY ON THE NET). Option -_C is synonymous to -_Z, but is being deprecated. -_b BITS --_b_i_t_s-_p_e_r-_c_o_d_e=BITS When doing compression, use '-bBITS' as a parameter to compress. The -_B option turns on the -_Z option by default. Default value is 12. PPPPrrrrooootttteeeeccccttttiiiinnnngggg aaaaggggaaaaiiiinnnnsssstttt ttttrrrraaaannnnssssmmmmiiiissssssssiiiioooonnnn eeeerrrrrrrroooorrrrssss:::: -_w --_n_o-_c_h_a_r_a_c_t_e_r-_c_o_u_n_t Do NOT check each file with 'wc -c' after unpack. The default is to check. -_D --_n_o-_m_d_5-_d_i_g_e_s_t Page 3 (printed 5/18/98) SSSSHHHHAAAARRRR((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11110000,,,, 1111999999995555)))) SSSSHHHHAAAARRRR((((1111)))) Do NOT use 'md5sum' digest to verify the unpacked files. The default is to check. -_F --_f_o_r_c_e-_p_r_e_f_i_x Forces the prefix character (normally 'X' unless the parameter to the -_d option starts with 'X') to be prepended to every line even if not required. This option may slightly increase the size of the archive, especially if -_B or -_Z is used. -_d XXX --_h_e_r_e-_d_e_l_i_m_i_t_e_r=XXX Use XXX to delimit the files in the shar instead of SHAR_EOF. This is for those who want to personalize their shar files. PPPPrrrroooodddduuuucccciiiinnnngggg ddddiiiiffffffffeeeerrrreeeennnntttt kkkkiiiinnnnddddssss ooooffff sssshhhhaaaarrrrssss:::: -_V --_v_a_n_i_l_l_a-_o_p_e_r_a_t_i_o_n Produce "vanilla" shars which rely only upon the existence of sed and echo in the unsharing environment. In addition, "if test" must also be supported unless the -_x option is used. The -_V silently disables options offensive to the "network cop" (or "brown shirt"), but does warn you if it is specified with -_B, -_z, -_Z, -_p or -_M (any of which does or might require uudecode, gzip or compress in the unsharing environment). -_P --_n_o-_p_i_p_i_n_g Use temporary files instead of pipes in the shar file. -_x --_n_o-_c_h_e_c_k-_e_x_i_s_t_i_n_g Overwrite existing files without checking. If neither -_x nor -_X is specified, the unpack will check for and not overwrite existing files when unpacking the archive. If -_c is passed as a parameter to the script when unpacking: sh archive -c then existing files will be overwritten unconditionally. -_X --_q_u_e_r_y-_u_s_e_r When unpacking, interactively ask the user if files should be overwritten. (DO NOT USE FOR SHARS SUBMITTED TO THE NET). -_m --_n_o-_t_i_m_e_s_t_a_m_p Avoid generating 'touch' commands to restore the file modification dates when unpacking files from the archive. Page 4 (printed 5/18/98) SSSSHHHHAAAARRRR((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11110000,,,, 1111999999995555)))) SSSSHHHHAAAARRRR((((1111)))) -_Q --_q_u_i_e_t-_u_n_s_h_a_r Verbose OFF. Disables the inclusion of comments to be output when the archive is unpacked. -_f --_b_a_s_e_n_a_m_e Restore by filename only, rather than path. This option causes only file names to be used, which is useful when building a shar from several directories, or another directory. Note that if a directory name is passed to shar, the substructure of that directory will be restored whether -_f is specified or not. IIIInnnntttteeeerrrrnnnnaaaattttiiiioooonnnnaaaalllliiiizzzzaaaattttiiiioooonnnn:::: --_n_o-_i_1_8_n Do not produce internationalized shell archives, use default english messages. By default, shar produces archives that will try to output messages in the unpackers preferred language (as determined by the LANG/LC_MESSAGES environmental variables) when they are unpacked. If no message file for the unpackers language is found at unpack time, messages will be in english. --_p_r_i_n_t-_t_e_x_t-_d_o_m_a_i_n-_d_i_r Prints the directory shar looks in to find messages files for different languages, then immediately exits. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS shar *.c > cprog.shar # all C prog sources shar -Q *.[ch] > cprog.shar # non-verbose, .c and .h files shar -B -l28 -oarc.sh *.arc # all binary .arc files, into # files arc.sh.01 thru arc.sh.NN shar -f /lcl/src/u*.c > u.sh # use only the filenames WWWWAAAARRRRNNNNIIIINNNNGGGGSSSS No chmod or touch is ever generated for directories created when unpacking. Thus, if a directory is given to shar, the protection and modification dates of corresponding unpacked directory may not match those of the original. If a directory is passed to shar, it may be scanned more than once. Therefore, one should be careful not change the directory while shar is running. Be careful that the output file(s) are not included in the inputs or shar may loop until the disk fills up. Be particularly careful when a directory is passed to shar that the output files are not in that directory (or a subdirectory of that directory). Use of the -_B, -_z or -_Z, and especially -_M, may slow the archive process considerably, depending on the number of Page 5 (printed 5/18/98) SSSSHHHHAAAARRRR((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11110000,,,, 1111999999995555)))) SSSSHHHHAAAARRRR((((1111)))) files. Use of -_X produces shars which _W_I_L_L cause problems with many unshar procedures. Use this feature only for archives to be passed among agreeable parties. Certainly, -_X is NOT for shell archives which are to be submitted to Usenet. Usage of -_B, -_z or -_Z in net shars will cause you to be flamed off the earth. Not using -_m or not using -_F may also get you occasional complaints. SSSSEEEEEEEE AAAALLLLSSSSOOOO unshar(1) DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS Error messages for illegal or incompatible options, for non-regular, missing or inaccessible files or for (unlikely) memory allocation failure. AAAAUUUUTTTTHHHHOOOORRRRSSSS The shar and unshar programs is the collective work of many authors. Many people contributed by reporting problems, suggesting various improvements or submitting actual code. A list of these people is in the THANKS file in the sharutils distribution. Page 6 (printed 5/18/98)